/**
 * Copyright (C) 2010 David Simonek <dafesimonek@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */

package org.dafe.partyband.importer.api;

import java.util.List;
import org.dafe.partyband.db.api.ISong;
import org.dafe.partyband.db.api.ISongResource;

/**
 *
 * @author dafe
 */
public interface ISongImport {

    ISong getSongInDb ();

    void setSongInDb (ISong song);

    ISong getSongToImport ();
    
    void setSongToImport (ISong song);

    IEvaluation getEvaluation ();

    void setEvaluation (IEvaluation eval);

    public interface IEvaluation {

        public enum Field { NAME, AUTHOR, SINGERS };

        boolean isImportEnabled (Field field);

        void setImportEnabled (Field field, boolean enabled);

        boolean isImportEnabled (ISongResource resource);

        void setImportEnabled (ISongResource resource, boolean enabled);

        void setImportEnabled (ISongResource resource, ISongResource dbResource, boolean value);

        ISongResource getDbResource(ISongResource resource);

        List<? extends IImportIssue> getIssues ();

        void addIssue (IImportIssue issue);

        void removeIssue (IImportIssue issue);

    }

    public interface IImportIssue {

        public enum Category { GENERAL, AUTHOR, SINGERS, RESOURCES, NAME };

        public enum Severity { DEFECT, WARNING, INFO };

        ISongResource getResourceInDb ();

        ISongResource getResourceToImport ();

        String getDescription ();

        Category getCategory ();

        Severity getSeverity ();

    }

    public interface IEvaluator {

        IEvaluation evaluate (ISongImport songImport);

        IEvaluation reevaluateAuthor (ISongImport songImport, IEvaluation evaluation);

        IEvaluation reevaluateSongName (ISongImport songImport, IEvaluation evaluation);
    }

}
